-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
1.0.3 #119
1.0.3 #119
Conversation
Windows 0805
The unit test for the This error was also occurring on a previous PR (39f9b33 and 3d17f5e) without reason. The tests run and pass locally, so I am not sure what is causing this error. I removed the specific tests for now. |
- Documentation typo in `download_modis` fixed: LPDAAC->LAADS - Link added
@mitchellmanware I think the updated codes are all good with my quick update #120. Thank you! |
MOD06_L2 link retrieval documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please confirm the "R CMD check --as-cran" check and the windows utility
@kyle-messier @sigmafelix Check on win-builder is complaining about "Serre" in the Local check passes with NOTES and a WARNING, but we can ignore these. The first NOTE just reports the maintainer name and "new submission". The second NOTE reports that the HTML manual cannot be checked because
I was receiving these same NOTES and WARNINGS in local checks before our previous submission, which passed the automated tests, so I am more concerned about the spelling error and the URL verification. Attached shows run of |
Updates from CRAN Submission amadeus 1.0.2
Italicized are the comments from the reviewer, and bullet points are my changes to address comment the comment or an explanation of why it was not adopted.
Please reduce the length of the title to less than 65 characters.
If there are references describing the methods in your package, please add these in the description field of your DESCRIPTION file in the form authors (year) doi:... authors (year, ISBN:...) or if those are not available: <https:...> with no space after 'doi:', 'https:' and angle brackets for auto-linking. (If you want to add a title as well please put it in quotes: "Title”)
DESCRIPTION
file updated with citation forcalc_sedc
function, which applies published statistical methods (https://pubs.acs.org/doi/10.1021/es203152a)Please always add all authors, contributors and copyright holders in the Authors@R field with the appropriate roles. From CRAN policies you agreed to: "The ownership of copyright and intellectual property rights of all components of the package must be clear and unambiguous (including from the authors specification in the DESCRIPTION file). Where code is copied (or derived) from the work of others (including from R itself), care must be taken that any copyright/license statements are preserved and authorship is not misrepresented. Preferably, an ‘Authors@R’ would be used with ‘ctb’ roles for the authors of such code. Alternatively, the ‘Author’ field should list these authors as contributors. Where copyrights are held by an entity other than the package authors, this should preferably be indicated via ‘cph’ roles in the ‘Authors@R’ field, or using a ‘Copyright’ field (if necessary referring to an inst/COPYRIGHTS file)." e.g.: -> "Spatiotemporal Exposures and Toxicology Group" in your LICENSE file Please explain in the submission comments what you did about this issue.
COPYRIGHT HOLDER
section of theLICENSE
file.Please add \value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \value{No return value, called for side effects} or similar) Missing Rd-tags:
calc_check_time.Rd: \value
calc_message.Rd: \value
check_for_null_parameters.Rd: \value
check_mysf.Rd: \value
check_mysftime.Rd: \value
download_data.Rd: \value
download_permit.Rd: \value
download_remove_command.Rd: \value
download_remove_zips.Rd: \value
download_run.Rd: \value
download_sink.Rd: \value
download_unzip.Rd: \value
test_download_functions.Rd: \value
\dontrun{} should only be used if the example really cannot be executed (e.g. because of missing additional software, missing API keys, ...) by the user. That's why wrapping examples in \dontrun{} adds the comment ("# Not run:") as a warning for the user. Does not seem always necessary. Please replace \dontrun with \donttest. Please unwrap the examples if they are executable in < 5 sec, or replace dontrun{} with \donttest{}. Please put functions which download data in \donttest{}.
download = FALSE
, so there is no data downloaded.process_*()
andcalc_*()
functions remain in the /donttest brackets.You write information messages to the console that cannot be easily suppressed. It is more R like to generate objects that can be used to extract the information a user is interested in, and then print() that object. Instead of print()/cat() rather use message()/warning() or if(verbose)cat(..) (or maybe stop()) if you really have to write text to the console. (except for print, summary, interactive functions) -> R/download.R
download_*()
functionscat()
command line commands to a .txt file on the user’s machine in order to download data files from URLs.cat()
is only used for writing these commands to text file.message()
andstop()
commands are used to provide the user with progress and error messages, respectively.Please ensure that your functions do not write by default or in your examples/vignettes/tests in the user's home filespace (including the package directory and getwd()). This is not allowed by CRAN policies. Please omit any default path in writing functions. In your examples/vignettes/tests you can write to tempdir(). -> download-functions and their examples
tempdir()
.eval = FALSE
, but they have also been updated to use thetempdir()
writing location.tempdir()
instead of manually creating/writing/removing directories within the “testdata” folder.Functionality Fixes
download_run
download_*()
functions were not downloading any data files when run on Windows OSdownload_run
for all OSdownload_remove_command
download_*()
function into thedownload_run
command while retaining all functionality and testsamadeus/R/download_auxiliary.R
Line 110 in d5683a6
download_remove_zips
pak::pak("NIEHS/amadeus@cran-0801")
to loadamadeus
in order to avoid accidental data deletion @kyle-messier @eva0marques @eva0marquesOther
@references
section for cleaner references in pkgdown websitecalc_lagged(geom = TRUE)
(did not work in last pull request for unknown reason)